Skip to main content
Use a safe, read-only request to confirm that the backend is reachable before attempting writes, checkout, or payment operations.

1. Determine the base URL

The repository .env.example defines application host, schema, port, and route-prefix settings. The README also describes the configured application port and an API documentation route. Build the URL from the values in your .env; do not assume a universal production URL or prefix.
If the configured prefix is already included in the base URL, do not append it again.

2. Inspect the API catalogue

When enabled, use the route configured by APIDOC_ENABLED and APIDOC_ROUTE (the template uses /apidoc). Swagger is separately configurable through SWAGGER_ENABLED, SWAGGER_ROUTE, and SWAGGER_FILE.

3. Make a read-only request

Choose a GET endpoint displayed by the running instance’s API documentation and known to be safe for your role and tenant.
For a protected route:
The route above is intentionally a placeholder. Do not use an endpoint copied from older v5 documentation without verifying it against v6.

4. Interpret the result

  • 2xx: transport/request succeeded; also inspect the application-level response.
  • 401: check token, expiry, and authentication scheme.
  • 403: check role, permission, resource ownership, and tenant context.
  • 404: check route prefix, edition, and whether the module is enabled.
  • 5xx: inspect sanitized server logs and database/provider health.
Do not use a write, order, payment, or destructive endpoint as a connectivity test.